Add `Image` validation rule #670

vjik · 2024-03-23T09:46:35Z

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	❌
Fixed issues

what-the-diff · 2024-03-23T09:46:53Z

PR Summary

Changelog Documentation Update
An entry has been made to the CHANGELOG.md file. This acts as the recording log of changes made.
File Information in Composer Checker
The composer-require-checker.json file has been updated to include "fileinfo".
PSR HTTP Message Dependency in Composer
The composer.json file has received an update to include the "psr/http-message", a fundamental component for handling HTTP messages.
New Image Rule File
A new Image rule file has been introduced. This is a central rule set related to image handling.
New ImageHandler File
A new ImageHandler file has been introduced. It will provide a programmatic interface to manipulate or otherwise interact with images.
RuleTestCase Update
Updates have been made to the RuleTestCase file, presumably improving or amplifying test coverage.
CompareTest Update
The CompareTest file has been updated, which likely means refinement in testing procedures for comparison-related functionalities.
New Images Addition
New 16x18.jpg and 16x18.png images have been introduced.
New ImageTest File
A new ImageTest file has been created. This suggests that an enhanced testing process is set up for image-related operations/features.

codecov · 2024-03-23T09:48:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (1.x@d9a7bf7). Click here to learn what that means.

Additional details and impacted files

@@          Coverage Diff           @@
##             1.x     #670   +/-   ##
======================================
  Coverage       ?   94.94%           
  Complexity     ?      835           
======================================
  Files          ?       96           
  Lines          ?     2553           
  Branches       ?        0           
======================================
  Hits           ?     2424           
  Misses         ?      129           
  Partials       ?        0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/Rule/ImageHandler.php

src/Rule/Image.php

src/Rule/ImageHandler.php

arogachev · 2024-03-26T09:02:48Z

src/Rule/Image.php

+        private ?int $maxWidth = null,
+        private ?int $maxHeight = null,
+        private string $notImageMessage = 'The value must be an image.',
+        private string $notExactlyWidthMessage = 'The width of image "{attribute}" must be exactly {exactly, number} {exactly, plural, one{pixel} other{pixels}}.',


Validating aspect ratio is quite a popular case too. Can be added iteratively in a separate PR.

src/Rule/Image.php

arogachev · 2024-03-26T09:27:11Z

Docs related additions - #671.

CHANGELOG.md

src/Rule/Image/ImageHandler.php

src/Rule/Image/Image.php

src/Rule/Image/ImageHandler.php

Co-authored-by: Alexander Makarov <sam@rmcreative.ru>

* update irc link (#663) * update docs folder link (#666) * Add methods `addErrorWithFormatOnly()` and `addErrorWithoutPostProcessing()` to `Result` object (#665) * Clarify psalm types in `Result` (#668) * Update result docs (#676) * Add `Image` validation rule (#670) Co-authored-by: Alexey Rogachev <arogachev90@gmail.com> Co-authored-by: Alexander Makarov <sam@rmcreative.ru> * Add missed params to `Image` rule options (#680) * Add date rules (#678) Co-authored-by: Alexander Makarov <sam@rmcreative.ru> * Add aspect ratio support to `Image` rule (#681) * Add aspect ratio support to `Image` rule * Apply fixes from StyleCI * Code coverage, mutants * Add detailed test cases' descriptions in data providers * Change placeholders * Work with options * Work with options 2 * More configuration checks * Fix logic, add PHPDoc * Use value object for aspect ratio * Actualize fix for mutant for absolute margin * Fix error messages * Fix new mutants * Update src/Rule/Image/ImageAspectRatio.php Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru> * Do not use dedicated container in tests, fix last mutant --------- Co-authored-by: StyleCI Bot <bot@styleci.io> Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru> * Release version 1.3.0 * Prepare for next release * Update guides in english and Translate guides into Brazilian Portuguese (#691) * Add `Result::add()` method for merging other results to the base one (#686) * Add `Result::add()` method for merging other results to the base one * Apply fixes from StyleCI * Update PR template [skip ci] * Update src/Result.php Co-authored-by: Alexander Makarov <sam@rmcreative.ru> --------- Co-authored-by: StyleCI Bot <bot@styleci.io> Co-authored-by: Alexander Makarov <sam@rmcreative.ru> * Add type rules and `Any` rule (#692) * Add type rules and handlers * Apply fixes from StyleCI * Mention in the docs + basic tests * Apply fixes from StyleCI * Fix copy paste [skip ci] * Test error message * Update changelog [skip ci] * Update PHPDoc [skip ci] * More tests and descriptions * Apply fixes from StyleCI * Include type in error message * Add Any rule * Apply fixes from StyleCI * Update changelog [skip ci] * Note [skip ci] * Add translations [skip ci] * Fix tests * Test attributes * Extract PHP >= 8.1 specific tests * Apply fixes from StyleCI * Extract PHP >= 8.1 specific tests 2 * Fix mutant * Update CHANGELOG.md Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru> * Rename Any to AnyRule (review) --------- Co-authored-by: StyleCI Bot <bot@styleci.io> Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru> * Rename `Any` rule in docs (#699) * Rename AnyHandler (remaining occurence) (#701) * Add methods for getting first error messages to `Result` (#697) * Add methods for getting first error messages to `Result` * Bump coverage * Update src/Result.php Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru> * Update src/Result.php Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru> * Apply fixes from StyleCI * Remove newline [skip ci] * Add changelog entry [skip ci] --------- Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru> Co-authored-by: StyleCI Bot <bot@styleci.io> * Translate Each rule docs into Russian (#688) * Add `Unique` rule (#695) * Add Unique rule * Apply fixes from StyleCI * More tests, messages [WIP] * Apply fixes from StyleCI * Test traslated attributes * Test using as attribute * Ready for review * Apply fixes from StyleCI * Update src/Rule/UniqueHandler.php Co-authored-by: Dmitriy Derepko <xepozz@list.ru> * Apply fixes from StyleCI * Slightly different approach * Apply fixes from StyleCI * New test case to check strict equality * Different approach * Minor adjustments * Remove comma, rename * Update changelog [skip ci] --------- Co-authored-by: StyleCI Bot <bot@styleci.io> Co-authored-by: Dmitriy Derepko <xepozz@list.ru> Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru> * Fix typo in array shape (#705) * Fix docs, translate brazilian portuguese (#708) Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru> * Release version 1.4.0 * Prepare for next release * Merge fixes --------- Co-authored-by: Ihor Sychevskyi <arhell333@gmail.com> Co-authored-by: Alexey Rogachev <arogachev90@gmail.com> Co-authored-by: Alexander Makarov <sam@rmcreative.ru> Co-authored-by: StyleCI Bot <bot@styleci.io> Co-authored-by: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Co-authored-by: Danil Arduanov <rylezz@gmail.com> Co-authored-by: Dmitriy Derepko <xepozz@list.ru>

vjik added 6 commits March 23, 2024 12:05

Add image validator

f00919b

Make fileinfo extension optional

c2c0c54

base tests

782f7aa

changelog

19c1523

fix and tests

e735480

phpdoc

a50b52d

vjik and others added 4 commits March 23, 2024 12:49

fix ci

6ba13e0

fix psalm

b2294ad

kill mutants

5c8e2b9

Apply fixes from StyleCI

48cbc71

xepozz approved these changes Mar 24, 2024

View reviewed changes

src/Rule/ImageHandler.php Outdated Show resolved Hide resolved

samdark reviewed Mar 24, 2024

View reviewed changes

src/Rule/Image.php Outdated Show resolved Hide resolved

src/Rule/Image.php Outdated Show resolved Hide resolved

src/Rule/ImageHandler.php Outdated Show resolved Hide resolved

arogachev self-requested a review March 26, 2024 07:38

arogachev mentioned this pull request Mar 26, 2024

Image validator additions #671

Merged

arogachev added the type:feature New feature label Mar 26, 2024

arogachev added this to the 1.3 milestone Mar 26, 2024

arogachev approved these changes Mar 26, 2024

View reviewed changes

arogachev reviewed Mar 26, 2024

View reviewed changes

src/Rule/Image.php Outdated Show resolved Hide resolved

Image validator additions (#671)

1bb0ab9

vjik commented Mar 26, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

9838b92

vjik added the status:under development Someone is working on a pull request. label Mar 26, 2024

vjik added 4 commits March 26, 2024 15:41

Info provider for Image rule (#672)

45cecc4

fix docs

6488b39

fix

75424d1

fix docs

7ef8dc5

BoShurik reviewed Mar 26, 2024

View reviewed changes

src/Rule/Image/ImageHandler.php Show resolved Hide resolved

vjik and others added 5 commits March 26, 2024 16:06

fix psalm

4a3f11a

kill mutants

8202957

Apply fixes from StyleCI

2994c6d

fix psalm

b42bd39

Merge branch '1.x' into image-validator

d2a8a4f

vjik added status:code review The pull request needs review. and removed status:under development Someone is working on a pull request. labels Mar 26, 2024

vjik requested a review from a team March 26, 2024 13:16

arogachev reviewed Mar 27, 2024

View reviewed changes

src/Rule/Image/ImageHandler.php Outdated Show resolved Hide resolved

samdark reviewed Mar 27, 2024

View reviewed changes

src/Rule/Image/Image.php Outdated Show resolved Hide resolved

src/Rule/Image/ImageHandler.php Outdated Show resolved Hide resolved

src/Rule/Image/ImageHandler.php Outdated Show resolved Hide resolved

vjik and others added 3 commits March 28, 2024 14:42

Update src/Rule/Image/Image.php

79c505f

Co-authored-by: Alexander Makarov <sam@rmcreative.ru>

Update src/Rule/Image/ImageHandler.php

10b9231

Co-authored-by: Alexander Makarov <sam@rmcreative.ru>

rename

4d62112

vjik merged commit 66cfeae into 1.x Mar 28, 2024
34 of 35 checks passed

vjik deleted the image-validator branch March 28, 2024 11:49

This was referenced Mar 28, 2024

Add file validator for out of the box solution. #591

Open

Allow to validate aspect ratio in Image rule #677

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `Image` validation rule #670

Add `Image` validation rule #670

vjik commented Mar 23, 2024

what-the-diff bot commented Mar 23, 2024

codecov bot commented Mar 23, 2024 •

edited

arogachev Mar 26, 2024

arogachev commented Mar 26, 2024

Add Image validation rule #670

Add Image validation rule #670

Conversation

vjik commented Mar 23, 2024

what-the-diff bot commented Mar 23, 2024

PR Summary

codecov bot commented Mar 23, 2024 • edited

Codecov Report

arogachev Mar 26, 2024

Choose a reason for hiding this comment

arogachev commented Mar 26, 2024

Add `Image` validation rule #670

Add `Image` validation rule #670

codecov bot commented Mar 23, 2024 •

edited